Parameter Keywords and Values for Allocation (Oracle OLAP Analytic Workspace Java API Reference)

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)
B14351-02

Parameter Keywords and Values for Allocation

The following table lists the keywords and values that are valid for a Parameter for an AllocationArgument. The table also contains brief descriptions of the actions specified by the keyword and values.

The items in the Keyword column are values that you can specify in a call to the setKeyWord method. Some keywords do not have an associated value, in which case the Value column for those keywords contains null. Some keywords are mutually exclusive, which is noted in the Description column. Some keywords have an effect only when used in conjuction with other keywords, which is also noted in the Description.

The items in the Value column are values that you can specify in a call to the setValue method. For the items that are in the Value column, capital letters indicate a literal value. More than one literal value in the Value column for a keyword indicates a mutually exclusive choice. Italic type face indicates a type of value for which you supply a scalar or other value.

For example, the following code sets the keywords and values of the Parameter objects param1 and param2.

  param1.setKeyWord("ADD_OR_ASSIGN");
  param1.setValue("ADD");

  param2.setKeyWord("MIN");
  param2.setValue("1");

Table of Parameter Keywords and Values for Allocation

Keyword	Value	Description
`ADD_OR_ASSIGN`	`ADD` `ASSIGN`	Specifies whether the operation adds the allocated value to the current value of the target `Measure` or replaces the current value with the allocated value. `ADD` specifies that the operation adds the allocated value to the current value of the target `Measure`. `ASSIGN` specifies that the operation assigns the allocated value to the target `Measure`, thereby replacing the previous value. This is a default parameter for an allocation.
`ADD_OR_MULTIPLY`	`ADD` `MULTIPLY`	Specifies whether the operation adds the weight value to the allocated value or multiplies the allocated value by the weight value before populating the target `Measure` with the resulting value. A `Parameter` with this keyword only has an effect if the `AllocationArgument` has a `Parameter` with the `WEIGHTBY` keyword. `ADD` specifies that operation adds the weight value to the allocated value. `MULTIPLY` specifies that operation multiplies the allocated value by the weight value.
`CEILING`	`ceiling value`	Specifies that if the value to allocate is greater than ceiling value, then the allocation assigns `NA` as the value for the target `Measure`. This parameter applies only to a proportional allocation, which is specified by an `AllocationOperator` with an `OperatorType` of `PROPORTIONAL`. As the ceiling value value, specify a `String` that designates a number to use as the ceiling value.
`FLOOR`	`floor value`	Specifies that when the value to allocate is less than floor value, then the allocation assigns `NA` as the value for the target `Measure`. This parameter applies only to a proportional allocation, which is specified by an `AllocationOperator` with an `OperatorType` of `PROPORTIONAL`. As the floor value value, specify a `String` that designates a number to use as the floor value.
`MAX`	`maximum value`	Specifies that when the value to allocate is greater than maximum value, then the allocation assigns maxval as the value for the target `Measure`. As the maximum value value, specify a `String` that designates a number to use as the maximum value.
`MIN`	`minimum value`	Specifies that when the value to allocate is less than minimum value, then the allocation assigns minimum value as the value for the target `Measure`. As the minimum value value, specify a `String` that designates a number to use as the minimum value.
`NAHANDLE`	`CONSIDER` `IGNORE` `PREFER`	Specifies how a `MAX` or `MIN` allocation operation determines which child has the minimum or maximum value when the child basis values include an `NA`. This parameter has an effect only when the `AllocationOperator` has an `OperatorType` of `MAX` or `MIN`. The values that you can set for the `NAHANDLE` keyword have the following effects. `CONSIDER` specifies that if the allocation operation must decide between a basis value of `NA` and a basis value of zero, then it considers that the zero value is the mininum or maximum value and the operation allocates the value to the child with the zero value. If the choice is between an `NA` value and a value other than zero, then `CONSIDER` specifies allocating the value to the child with the `NA` value. In that case, the allocation treats the `NA` value as a zero for the remainder of the operation. `IGNORE` specifies that the allocation ignores `NA` values and selects a non-`NA` child value as the basis for the allocation. This is the default parameter for a `MAX` or `MIN` operation. `PREFER` specifies that an `NA` basis value is the maximum or minimum value compared to a zero value, and the operation allocates the value to the child with the `NA` value. The allocation treats the `NA` value as a zero for the remainder of the operation.
`NORMALIZE`	`NORMALIZE` `NONORMALIZE`	Specifies whether the allocation operation normalizes the basis values. A `Parameter` with this keyword only has an effect if the `AllocationArgument` has a `Parameter` with the `PROTECTLIST` keyword. `NORMALIZE` specifies normalizing the basis values of the dimension members designated by a `Parameter` with the `PROTECTLIST` keyword. This is the default value. `NONORMALIZE` specifies that the allocation operation does not normalize the basis values. Not normalizing the basis values effective removes from the allocation the values specified by the hierarchy members at and below the dimension members specified by the `PROTECTLIST` parameter.
`PROTECTLIST`	`member selection`	Identifies a set of dimension members that you want to protect so that the values that they specify do not participate in the allocation. By default, before allocating the basis values, the allocation operation normalizes the values by subtracting from them the values specified by the protected members. In the target `Measure`, the values specified by the protected members are not changed by the allocation. To prevent normalizing the values, add a `Parameter` with the `NONORMALIZE` keyword to the `AllocationArgument`. As the member selection value, specify a `String` that designates one or more dimension members. You can specify dimension members by member value or by attribute value. You can also specify all of the dimension members of a level. The syntax for specifying a dimension member by member value is the following. `Dimension_Name.DIMENSION:"Member_Value"` The syntax for specifying a dimension member by attribute value is the following. `Dimension_Name.Attribute_Name.ATTRIBUTE="Attribute_Value"` `The syntax for specifying all of the dimension members of a level is the following.` Dimension_Name.Level_Name.LEVEL `The following are examples of specifying dimension members to protect. In the examples, the` protectList object is a `Parameter`. // Specifies the dimension member that has the value 13. protectList.setKeyWord("PROTECTLIST"); protectList.setValue("PRODUCT_AW.DIMENSION:\"13\""); // Specifies three dimension members. //You can separate the members with a space or a comma. protectList.setValue("PRODUCT_AW.DIMENSION:\"13\"", "PRODUCT_AW.DIMENSION:\"14\"", "PRODUCT_AW.DIMENSION:\"15\""); // Specifies the dimension members that have the PACKAGE_AW attribute // value Executive. protectList.setValue("PRODUCT_AW.PACKAGE_AW.ATTRIBUTE=/"Executive/""); // Specifies the FAMILY_AW Level. protectList.setValue("PRODUCT_AW.FAMILY_AW.LEVEL");
`READWRITE`	`null`	Specifies that a subsequent allocation operation cannot use as basis values the `Measure` values specified by the `PROTECTLIST` dimension members. This parameter locks the values specified by the members of the hierarchy that are below the `PROTECTLIST` dimension members. Mutually exclusive with `WRITE`. A `Parameter` with this keyword only has an effect if the `AllocationArgument` has a `Parameter` with the `PROTECTLIST` keyword.
`WEIGHTBY`	weight object	Specifies that the allocation operation uses the values in the weight object object to weight the allocated values. As the weight object value, give the name of a `Measure` or `Attribute` that provides the weight values. To specify a value to substitute for `NA` values in the weight object object, use a `Parameter` with the `WNAFILL` keyword.
`WNAFILL`	NA fill value	Specifies a value to substitute for `NA` values in the weight object object specified by a `Parameter` with the `WEIGHTBY` keyword. A `Parameter` with this keyword only has an effect if the `AllocationArgument` has a `Parameter` with the `WEIGHTBY` keyword. As the NA fill value value, specify a `String` that designates a number to use to replace an `NA` weight value. The default NA fill value value is `0` (zero) for an weighted allocation that has the `ADD_OR_MULTIPLY` parameter with the value of `ADD` or `1` for that parameter with a value of `MULTIPLY`.
`WRITE`	`null`	Specifies that the allocation cannot put allocated values in the target `Measure` for the values specified by the `PROTECTLIST` dimension members, but the allocation can use the target values as basis values in subsequent steps. However, if the value returned by the `getSourceVal` method of the `AllocationDefinition` is `NA` or `ZERO` and the `Measure` value for the protected dimension member is the basis of an allocation, then the allocation sets the value for the protected member to `NA` or zero after the allocation. Mutually exclusive with `READWRITE`. A `Parameter` with this keyword only has an effect if the `AllocationArgument` has a `Parameter` with the `PROTECTLIST` keyword.